Health and Social Care Integration
Domain Message Specification

WithdrawalNoticeRejectResponse Tabular View

COMT_RM020001GB01
WithdrawalNoticeRejectResponse
A reject response to a Withdrawal Notice under the Care Act 2014 Schedule 3.
Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="INFRM" }

Model Attribute Description

The HL7 attribute classCode describes the type of act using a value from the ActClassRoot domain of the HL7 vocabulary ActClass.

Implementation in XML Instance

  • The XML attribute classCode shall carry a fixed code of "INFRM".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a inform event.

Implementation in XML Instance

The XML attribute moodCode is fixed to " EVN".
[1..1] [M] code (CV { CNE:SnomedCT } )
{ Fixed="1025641000000106" }

Model Attribute Description

The HL7 attribute code uses a code from a SNOMED CT vocabulary to indicate that this is a Withdraw Notice Reject under the Care Act 2014 Schedule 3.

Implementation in XML Instance

The Coded with Code System flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code is fixed to "1025641000000106".
  • The XML attribute codeSystem is fixed to "2.16.840.1.113883.2.1.3.2.4.15".
[1..1] [M] effectiveTime (TS)

The HL7 attribute effectiveTime is used to define the creation time of the CDA document.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time the document was created using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

[1..2] [M] id (SET<II>)

Model Attribute Description

The HL7 attribute id uses an identifier to identify an instance of a telehealth service event.

Implementation in XML Instance

The Identifier Global data type flavour shall be used to carry this information in the XML element id in the following way:

The first instance of id shall DCE UUID to identify the service event as below:

  • The XML attribute root shall contain a DCE UUID.

When using a local identifier to further identify the service event for local use then:

  • The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.40"
  • The XML attribute extension shall contain the local identifier
  • The XML attribute assigningAuthorityName shall contain the assigning organisation in the format of ODSCode:ODSName, for example:
assigningAuthorityName=" RA9:SOUTH DEVON HEALTHCARE NHS TRUST
[1..1] [M] author

This class is a participant of authorship. It holds details of how and when the author authored the CDA document.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="AUT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as an author participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "AUT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100030#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (AuthorChoice)
A link to the choice of author templates.
[1..1] [M] primaryInformationRecipient

This class is a primary information recipient participation.

The primary information recipients of the clinical documents are usually expected to perform some action on receipt of a CDA document. There can be more than one primary recipient.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="PRCP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a primary information recipient participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "PRCP".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the data enterer replaces any data enterer that has been conducted from any previous acts.
  • "P" (Propagating) - the data enterer is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100022#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (RecipientChoice)
A link to the choice of primary information recipient templates.
[1..1] [M] reason
The reason for the Withdrawal Notice Reject Response.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="RSON" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe the type of relationship as one of a reason.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "RSON".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] justifyingWithdrawalRejectionReason (WithdrawalRejectionReason)
A link to the reason for the Withdrawal Notice Reject Response.
[1..1] [M] recordTarget

A class which is a participation of record target (The patient whose record is the target for the information in the Document.)

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="RCT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a record target participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "RCT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the record target replaces any record target that has been conducted from any previous acts.
  • "P" (Propagating) - the record target is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100021#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (Patient)
A link to the patient role templates.
[1..1] [M] reference
A reference to the Withdrawal Notice being rejected.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="REFR" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe the type of relationship as one of reference.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "REFR".
[1..1] [M] referredToReferredToWithdrawalNotification (ReferredToWithdrawalNotification)
A link to the Withdrawal Notice being referred to.
[1..1] [M] responsibleParty

A class which holds details of how the person was responsible for the encompassing encounter.

Note this participation is required to be included if available on the sending system.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="RESP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a responsible party participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "RESP".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the data enterer replaces any data enterer that has been conducted from any previous acts.
  • "P" (Propagating) - the data enterer is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100024#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (ResponsiblePartyChoice)
A link to the choice of responsible parties.
AuthorChoice
An abstract placeholder for the templates for an author.
Used by: WithdrawalNoticeRejectResponse
[1..1] : Template2
Patient
An abstract placeholder for the templates of a patient.
Used by: WithdrawalNoticeRejectResponse
[1..1] : Template3
RecipientChoice
An abstract placeholder for the templates of a recipient.
Used by: WithdrawalNoticeRejectResponse
[1..1] : Template4
ResponsiblePartyChoice
An abstract placeholder for the templates of a responsible party.
Used by: WithdrawalNoticeRejectResponse
[1..1] : Template5
ReferredToWithdrawalNotification
The Withdrawal Notice referred to for the Withdrawal Notice Reject Response.
Used by: WithdrawalNoticeRejectResponse
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="INFRM" }

Model Attribute Description

The HL7 attribute classCode describes the type of act using a value from the ActClassRoot domain of the HL7 vocabulary ActClass.

Implementation in XML Instance

  • The XML attribute classCode shall carry a fixed code of "INFRM".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a inform event.

Implementation in XML Instance

The XML attribute moodCode is fixed to " EVN".
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify an instance of a telehealth service event.

Implementation in XML Instance

The Identifier Global data type flavour shall be used to carry this information in the XML element id in the following way:

The first instance of id shall DCE UUID to identify the service event as below:

  • The XML attribute root shall contain a DCE UUID.

When using a local identifier to further identify the service event for local use then:

  • The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.40"
  • The XML attribute extension shall contain the local identifier
  • The XML attribute assigningAuthorityName shall contain the assigning organisation in the format of ODSCode:ODSName, for example:
assigningAuthorityName=" RA9:SOUTH DEVON HEALTHCARE NHS TRUST
WithdrawalRejectionReason
The reason for the Withdrawal Notice Reject Response.
Used by: WithdrawalNoticeRejectResponse
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:ObservationType } )
{ Fixed="WRR" }

Model Attribute Description

The HL7 attribute code uses a code from the ObservationType vocabulary to indicate that this is an observation of the reason for the Withdrawal Notice rejection.

Implementation in XML Instance

The Coded with Code System Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value of "WRR"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.275"
  • The XML attribute displayName shall contain the text associated with the code.
[1..1] [M] id (II)

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at run time with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] value (ST)
Model Attribute Description

The HL7 attribute value is used to carry the information about the content of the additional notes, this value is associated with the HL7 attribute code of this class.

Implementation in XML Instance
  • The XML attribute xsi:type shall contain the value "ST".
  • The XML element value shall contain the information.